Skip to content

Unload scripts created by websocket command execute_script#169368

Merged
frenck merged 2 commits intodevfrom
websocket_api_unload_script
Apr 29, 2026
Merged

Unload scripts created by websocket command execute_script#169368
frenck merged 2 commits intodevfrom
websocket_api_unload_script

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery commented Apr 28, 2026

Proposed change

Unload scripts created by websocket command execute_script

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings April 28, 2026 12:10
@emontnemery emontnemery requested a review from a team as a code owner April 28, 2026 12:10
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Apr 28, 2026

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (websocket_api) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of websocket_api can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign websocket_api Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copilot AI reviewed Apr 28, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to clean up Script objects created by the websocket execute_script command to avoid leaving behind resources after a script run.

Changes:

  • Add a finally block in handle_execute_script to call script_obj.async_unload() after execution (success or failure).
  • Add a new test that asserts async_unload() is called when running execute_script.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
homeassistant/components/websocket_api/commands.py Adds cleanup via finally: script_obj.async_unload() for execute_script.
tests/components/websocket_api/test_commands.py Adds a mocked-unit test asserting async_unload() is invoked.

Comment thread homeassistant/components/websocket_api/commands.py
Comment thread homeassistant/components/websocket_api/commands.py
Comment on lines +1079 to +1080
finally:
script_obj.async_unload()
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prevent async_unload() errors from bubbling out of the finally block by stopping the script (or suppressing RuntimeError) before unloading, otherwise task cancellation or other edge cases can raise during cleanup and mask the original outcome / potentially lead to double error handling.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

@emontnemery emontnemery Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems extremely improbable. Scripts clean up after themselves, also when they error, through the _finish method:

core/homeassistant/helpers/script.py

Lines 539 to 544 in 46297fd

def _finish(self) -> None:
self._script._runs.remove(self) # noqa: SLF001
if not self._script.is_running:
self._script.last_action = None
self._changed()
self._stopped.set()

The only real risk is if the cleanup here is itself cancelled, but I don't think that matters for the websocket command handler:

core/homeassistant/helpers/script.py

Lines 1872 to 1875 in 46297fd

except asyncio.CancelledError:
await run.async_stop()
self._changed()
raise

Comment thread tests/components/websocket_api/test_commands.py
@emontnemery
Copy link
Copy Markdown
Contributor Author

emontnemery commented Apr 28, 2026

Set to draft until I've taken a closer look at the bot comments.

@emontnemery emontnemery marked this pull request as draft April 28, 2026 14:03
@emontnemery emontnemery marked this pull request as ready for review April 29, 2026 01:15
@frenck frenck merged commit a95c216 into dev Apr 29, 2026
85 of 86 checks passed
@frenck frenck deleted the websocket_api_unload_script branch April 29, 2026 08:24
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@frenck frenck frenck approved these changes

Assignees

No one assigned

Labels

by-code-owner cla-signed code-quality core has-tests integration: websocket_api Quality Scale: internal small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@emontnemery @frenck